/*
 * Copyright (c) 2002-2007, Mairie de Paris
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  1. Redistributions of source code must retain the above copyright notice
 *     and the following disclaimer.
 *
 *  2. Redistributions in binary form must reproduce the above copyright notice
 *     and the following disclaimer in the documentation and/or other materials
 *     provided with the distribution.
 *
 *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
 *     contributors may be used to endorse or promote products derived from
 *     this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 * License 1.0
 */
package fr.paris.lutece.plugins.customisation.business.tab;

import fr.paris.lutece.portal.service.spring.SpringContextService;
import fr.paris.lutece.util.ReferenceList;

import java.util.List;


/**
 * This class provides instances management methods (create, find, ...) for CustomisationTab objects
 */
public final class CustomisationTabHome
{
    //	 Static variable pointed at the DAO instance
    private static ICustomisationTabDAO _dao = (ICustomisationTabDAO) SpringContextService.getPluginBean( "customisation",
            "customisationTabDAO" );

    /**
     * Private constructor - this class need not be instantiated
     */
    private CustomisationTabHome(  )
    {
    }

    /**
     * Returns the Tab whose primary key is specified in parameter
     *
     * @param nIdTab the tab identifier
     * @return The tab object
     */
    public static CustomisationTab findByPrimaryKey( int nIdTab )
    {
        return _dao.load( nIdTab );
    }

    /**
     * Create a new tab in the table
     *
         * @param strNameTab the tab name
         * @param strUserName the user identifier
         * @param nOrderTab the order of the tab
         * @param nIdTemplate the template identifier
         * @param strCodeTheme the code of the theme
         * @param firstColumnWidth the width of the first column
         * @param secondColumnWidth the width of the second column
         * @param thirdColumnWidth the width of the third column
     */
    public static void create( String strNameTab, String strUserName, int nOrderTab, int nIdTemplate,
        String strCodeTheme, int firstColumnWidth, int secondColumnWidth, int thirdColumnWidth  )
    {
        _dao.insert( strNameTab, strUserName, nOrderTab, nIdTemplate, strCodeTheme, firstColumnWidth, secondColumnWidth, thirdColumnWidth );
    }

    /**
     * Update the tab whose primary key is specified in parameter
     *
     * @param nIdTab the tab identifier
     * @param strNameTab the tab name
     * @param strUserName the user identifier
     * @param nOrderTab the order of the tab
     * @param nIdTemplate the template identifier
     * @param strCodeTheme the code of the theme
     * @param firstColumnWidth the width of the first column
     * @param secondColumnWidth the width of the second column
     * @param thirdColumnWidth the width of the third column
     */
    public static void update( int nIdTab, String strNameTab, String strUserName, int nOrderTab, int nIdTemplate,
        String strCodeTheme, int firstColumnWidth, int secondColumnWidth, int thirdColumnWidth  )
    {
        _dao.store( nIdTab, strNameTab, strUserName, nOrderTab, nIdTemplate, strCodeTheme, firstColumnWidth, secondColumnWidth, thirdColumnWidth );
    }

    /**
     * Delete the tab whose primary key is specified in parameter
     *
     * @param nIdTab the tab identifier
     * @param strUserName the user identifier
     */
    public static void remove( int nIdTab, String strUserName )
    {
        _dao.delete( nIdTab, strUserName );
    }

    /**
     * Returns the list of tabs according the user identifier
     *
     * @param strUserName the user identifier
     * @return the list of tabs according the user identifier
     */
    public static ReferenceList getAllTabUser( String strUserName )
    {
        return _dao.selectAllTabUser( strUserName );
    }

    /**
     * Returns the list of tabs according the user identifier
     *
     * @param strUserName the user identifier
     * @return the list of tabs according the user identifier
     */
    public static List<CustomisationTab> getTabUser( String strUserName )
    {
        return _dao.selectTabUser( strUserName );
    }

    /**
     * Returns the last tab created by the User
     *
     * @param strUserName The User Identifier
     * @return the last tab created by the User
     */
    public static int getLastTab( String strUserName )
    {
        return _dao.selectLastTab( strUserName );
    }

    /**
     * Returns a boolean condition about the presence or not of an user
     *
     * @param strUserName The user identifier
     * @return a boolean condition
     */
    public static boolean getCheckUser( String strUserName )
    {
        return _dao.checkUser( strUserName );
    }

    /**
     * Returns the tab's number for an user
     *
     * @param strUserName The user identifier
     * @return The tab's number for an user
     */
    public static int getCountTabByUser( String strUserName )
    {
        return _dao.selectCountTabByUser( strUserName );
    }
}
